Android Jewelry SDK/com.postindustria.android.jewelryar.unity.communication.events.entities

Package com.postindustria.android.jewelryar.unity.communication.events.entities

Types

data class AttemptedModelDescription( val name: String? = null, val mae: Double? = null, val key: String? = null, val hash: String? = null, val id: Int? = null, val type: String? = null, val url: String? = null)

Model description received from the API Server (if available)

CurrentDownloads

data class CurrentDownloads(val models: List<DownloadOperation>? = null, val tfModels: List<DownloadOperation>? = null)

Active or just finished download operations.

DownloadOperation

data class DownloadOperation( val tag: Tag? = null, val url: String? = null, val bytesLoaded: Long? = null, val progress: Double, val isFinished: Boolean)

A description of download operation (active or just finished).

DownloadProgress

data class DownloadProgress(val currentDownloads: CurrentDownloads? = null) : Event

Event data class used to inform the Host app on the progress of active downloads

EndpointData

data class EndpointData(val baseUrl: String, val authInfo: AuthInfo? = null)

Describes a remote server endpoint combined with designated parameters.

EndpointErrorEvent

data class EndpointErrorEvent( val url: String? = null, val webRequestResult: Int? = null, val webRequestResultDescription: String?, val responseCode: Short? = null, val errors: List<Error>, val rawResponse: String? = null) : Event

Event data class used to report failure to get data from remote API server.

Error

data class Error(val message: String? = null, val reason: String?)

Single error of endpoint.

ErrorReport

data class ErrorReport(val failedStep: String? = null, val additionalInfo: String? = null)

Generic and minimalistic description of some failure.

Event

sealed class Event

Superclass for all the events

HandDetectorReplacedEvent

data class HandDetectorReplacedEvent(val tfOutputFormat: TfOutputFormat? = null) : Event

Event data class used to inform the host on the activation of Hand Detector.

HandDetectorState

data class HandDetectorState( val isLoaded: Boolean, val isLoading: Boolean, val downloadOperations: List<DownloadOperation> = emptyList())

Contains all the information about the hand detector.

ModelInfo

data class ModelInfo(val hash: String? = null, val modelPath: String? = null)

Information on the local version of TF Model.

RingLoadingFailure

data class RingLoadingFailure(val ring: Ring, val failedLoadingStep: String? = null)

Data class used to describe a failure with displaying a ring.

RingState

data class RingState( val displayedRing: Ring? = null, val pendingReplacement: Ring? = null, val downloadOperations: List<DownloadOperation> = emptyList(), val ringsAlive: List<RingModel> = emptyList())

Contains all the information about the ring.

RingTag

data class RingTag(val model: RingModel? = null) : Tag

RingModel-based tag using for the ring download operation.

SceneState

data class SceneState(val handDetectorState: HandDetectorState, val ringStates: RingState)

State of the current scene.

StringTag

data class StringTag(val info: String? = null) : Tag

String-based tag using for TF Models download operations.

Tag

sealed class Tag

Purpose of the download operation.

TfModelsUpdateCheckpoint

data class TfModelsUpdateCheckpoint(val fingerModelReport: TfModelUpdateReport? = null, val handModelReport: TfModelUpdateReport? = null) : Event

Event data class used to inform about the presence/absence of errors in the loading of TensorFlow neural models.

TfModelUpdateReport

data class TfModelUpdateReport( val attemptedEndpoint: EndpointData? = null, val attemptedModelDescription: AttemptedModelDescription? = null, val errorReport: ErrorReport? = null, val loadedModelInfo: ModelInfo? = null, val fallbackModelInfo: ModelInfo? = null)

A report on the outcome of TensorFlow neural model loading operation.

TfOutputFormat

data class TfOutputFormat( val enumValue: Int? = null, val enumValueString: String? = null, val spatialDimensionality: Int? = null, val pointsPerFinger: Int? = null, val maxFingersCount: Int? = null)

The information about the format of the neural model.

UnexpectedSslCertFingerprintEvent

data class UnexpectedSslCertFingerprintEvent(val sslCertFingerprint: String? = null) : Event

Event data class used to report mismatch of sent SSL Certificate Fingerprint with the one on the server.